Counterparties Invoices

GET /api/v1/Counterparties/invoices

Description

This endpoint is used to retrieve a list of invoices for a specific counterparty. It returns a GetAllInvoicesResponseListPagedResponse object containing information about the invoices.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• counterpartyId: string, format: uuid, required, the id of the counterparty for which to retrieve the invoices

• pageNumber: integer, format: int32, optional, the page number (default is 1)

• pageSize: integer, format: int32, optional, the number of items to include per page (default is 10)

Request Body:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/Counterparties/invoices

Response:

• A GetAllInvoicesResponseListPagedResponse object containing information about the invoices.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/invoices?counterpartyId=1234567890&pageSize=5&pageNumber=1

Response:

HTTP/1.1 200 OK
{
  "totalItems": 3,
  "pageNumber": 1,
  "pageSize": 5,
  "items": [
    {
      "invoiceId": "1234567890",
      "invoiceNumber": "INV0001",
      "amount": 1000.00,
      "status": "Paid"
    },
    {
      "invoiceId": "0987654321",
      "invoiceNumber": "INV0002",
      "amount": 1500.00,
      "status": "Pending"
    },
    {
      "invoiceId": "9876543210",
      "invoiceNumber": "INV0003",
      "amount": 2000.00,
      "status": "Paid"
    }
  ]
}

Method: GET

/api/v1/Counterparties/invoices?counterpartyId=<uuid>&pageNumber=1&pageSize=10

Headers

Content-Type	Value
Accept	text/plain

Query Params

Param	value
counterpartyId	<uuid>
pageNumber	1
pageSize	10

Response: 200

{
  "pageNumber": "<integer>",
  "pageSize": "<integer>",
  "total": "<integer>",
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": [
    {
      "id": "<uuid>",
      "invoiceId": "<string>",
      "counterPartyName": "<string>",
      "accountName": "<string>",
      "dueDate": "<dateTime>",
      "currency": 1,
      "discountType": 2,
      "description": "<string>",
      "billingCycle": 2,
      "recuringInvoice": "<boolean>",
      "paymentOption": 8,
      "userId": "<uuid>",
      "amount": "<double>",
      "notifications": "<string>",
      "paidAmount": "<double>",
      "created": "<dateTime>",
      "invoiceStatus": 4,
      "beforeDueDate": 4,
      "afterDueDate": 7,
      "onDueDate": "<boolean>"
    },
    {
      "id": "<uuid>",
      "invoiceId": "<string>",
      "counterPartyName": "<string>",
      "accountName": "<string>",
      "dueDate": "<dateTime>",
      "currency": 2,
      "discountType": 1,
      "description": "<string>",
      "billingCycle": 2,
      "recuringInvoice": "<boolean>",
      "paymentOption": 7,
      "userId": "<uuid>",
      "amount": "<double>",
      "notifications": "<string>",
      "paidAmount": "<double>",
      "created": "<dateTime>",
      "invoiceStatus": 4,
      "beforeDueDate": 6,
      "afterDueDate": 5,
      "onDueDate": "<boolean>"
    }
  ]
}